Collection::Remove

Section: ET++ method description (n)
Updated: automatically Fri Mar 1 10:57:30 1991
Index Return to Main Contents
 

NAME

Collection::Remove - instance method  

TEMPLATE

removedObject = ObjPtr Remove(ObjPtr anObject)  

SPECIFIERS

public abstract virtual  

DESCRIPTION

Attempts to remove an element from the receiver which is equal to anObject in the sense of @Object::IsEqual. If there has been such an element, Remove returns it, otherwise 0 is returned.
In SeqCollections, the element with the least index is removed if more than one element is equal to anObject.
A succesful Remove operation sends the default change message. See also method RemovePtr and method RemoveAll. Method is often overridden.  

ARGUMENTS

ObjPtr anObject

Object to be removed.
 

RETURN ARGUMENT

ObjPtr removedObject
 

CATEGORIES

manipulation, client interface, overrider interface

 

FIRST DEFINITION

class Collection  

FILES

implementation:
Collection.C

 

KNOWN PROBLEMS

It is undefined wether the IsEqual operation is invoked on anObject or on some elements of the receiver.
Some implementations do send no change message at all.


 

Index

NAME
TEMPLATE
SPECIFIERS
DESCRIPTION
ARGUMENTS
RETURN ARGUMENT
CATEGORIES
FIRST DEFINITION
FILES
KNOWN PROBLEMS

This document was created by man2html, using the manual pages.
Time: 00:40:30 GMT, March 30, 2022